Get Contract

Get Contract

in case you want to get previously created contract by contract id, you can use the following endpoint

Endpoint GET {{baseUrl}}/apps/api/contracts/CNT-2601-00100002 Curl:

```bash
curl -X 'GET' \
  '{{baseUrl}}/apps/api/contracts/CNT-2601-00100002' \
  -H 'accept: application/json'

Response

{
	"data": {
		"contractId": "CNT-2601-00100002",
		"reference": "12321",
		"title": "Sell a property111",
		"description": "Extenal Iphone mobile",
		"notes": "notes for mobile",
		"status": "pending",
		"contractServiceType": "product",
		"buyerParty": {
			"platformRefId": "USR_123",
			"firstName": "Buyer",
			"lastName": "Name aa",
			"phoneNumber": "966583944460"
		},
		"sellerParty": {
			"platformRefId": "USR_456",
			"firstName": "Seller",
			"lastName": "",
			"phoneNumber": "966583944461"
		},
		"businessName": "new 555",
		"createdDate": "2026-01-24T17:48:58.64975+01:00",
		"metaData": {
			"metadata1": "1",
			"metadata2": "2",
			"metadata3": "",
			"metadata4": ""
		},
		"milestones": [
			{
				"Id": 12,
				"Name": "milestone 1 name",
				"Description": "milestone 1 description",
				"DueDate": "2026-12-20T10:00:00.000Z",
				"Amount": 686.25,
				"PricingLineItems": [
					{
						"lineType": "contractAmount",
						"role": "buyer",
						"amount": 600,
						"description": null,
						"order": 1
					},
					{
						"lineType": "escrowFee",
						"role": "thirdParty",
						"amount": 15.0,
						"description": null,
						"order": 2
					},
					{
						"lineType": "escrowFeeTax",
						"role": "thirdParty",
						"amount": 2.25,
						"description": null,
						"order": 3
					},
					{
						"lineType": "externalPlatformFee",
						"role": "buyer",
						"amount": 60.00,
						"description": null,
						"order": 4
					},
					{
						"lineType": "externalPlatformFeeTax",
						"role": "buyer",
						"amount": 9.00,
						"description": null,
						"order": 5
					},
					{
						"lineType": "netEscrowAmountToSeller",
						"role": "seller",
						"amount": 600,
						"description": null,
						"order": 6
					}
				]
			},
			{
				"Id": 13,
				"Name": "milestone 2 name",
				"Description": "milestone 2 description",
				"DueDate": "2026-12-31T09:35:30.369Z",
				"Amount": 457.5,
				"PricingLineItems": [
					{
						"lineType": "contractAmount",
						"role": "buyer",
						"amount": 400,
						"description": null,
						"order": 1
					},
					{
						"lineType": "escrowFee",
						"role": "thirdParty",
						"amount": 10.00,
						"description": null,
						"order": 2
					},
					{
						"lineType": "escrowFeeTax",
						"role": "thirdParty",
						"amount": 1.50,
						"description": null,
						"order": 3
					},
					{
						"lineType": "externalPlatformFee",
						"role": "buyer",
						"amount": 40.00,
						"description": null,
						"order": 4
					},
					{
						"lineType": "externalPlatformFeeTax",
						"role": "buyer",
						"amount": 6.00,
						"description": null,
						"order": 5
					},
					{
						"lineType": "netEscrowAmountToSeller",
						"role": "seller",
						"amount": 400,
						"description": null,
						"order": 6
					}
				]
			}
		],
		"pricingLineItems": [
			{
				"lineType": "contractAmount",
				"role": "buyer",
				"amount": 1000,
				"description": null,
				"order": 1
			},
			{
				"lineType": "escrowFee",
				"role": "thirdParty",
				"amount": 25.0,
				"description": null,
				"order": 2
			},
			{
				"lineType": "escrowFeeTax",
				"role": "thirdParty",
				"amount": 3.75,
				"description": null,
				"order": 3
			},
			{
				"lineType": "externalPlatformFee",
				"role": "buyer",
				"amount": 100.0,
				"description": null,
				"order": 4
			},
			{
				"lineType": "externalPlatformFeeTax",
				"role": "buyer",
				"amount": 15.0,
				"description": null,
				"order": 5
			},
			{
				"lineType": "netEscrowAmountToSeller",
				"role": "seller",
				"amount": 1000,
				"description": null,
				"order": 6
			}
		],
		"transactions": []
	},
	"message": "ContractRetrievedSuccessfully",
	"status": 200,
	"validationErrors": []
}

Response Fields Description Result<GetContractResponse>

Field Name	Type	Description	Required / Notes / Example
succeeded	boolean	Indicates whether the request was successful	Required
message	string	Response message	Optional
errors	array of string	Errors if the request failed	Optional
data	object (GetContractResponse)	Contract details	Optional

GetContractResponse

Field Name	Type	Description	Required / Notes / Example
id	string (GUID)	Contract identifier	Required
title	string	Contract title	Required
description	string	Contract description	Optional
notes	string	Additional notes	Optional
amount	number	Total contract amount	Required
status	string (ContractStatus)	Current contract status	Required
contractServiceType	string (ContractServiceType)	Contract service type	Required
reference	string	External reference	Optional
buyerParty	object (ExternalContractParty)	Buyer party details	Required
sellerParty	object (ExternalContractParty)	Seller party details	Required
metaData	object (ContractMetaData)	Custom metadata	Optional
milestones	array of ContractMilestoneResponse	Contract milestones	Required
pricingLineItems	array of PricingLineItemResponse	Pricing breakdown	Required
createdDate	string (date-time) (UTC)	Contract creation date (UTC)	Required
updatedDate	string (date-time) (UTC)	Last update date (UTC)	Required

ExternalContractParty

Field Name	Type	Description	Required / Notes / Example
platformRefId	string	User identifier in wepay	Required
firstName	string	First name	Required
lastName	string	Last name	Optional
phoneNumber	string	Phone number with country code	Required

ContractMetaData

Field Name	Type	Description	Required / Notes / Example
metadata1	string	Custom metadata	Optional
metadata2	string	Custom metadata	Optional
metadata3	string	Custom metadata	Optional
metadata4	string	Custom metadata	Optional

ContractMilestoneResponse

Field Name	Type	Description	Required / Notes / Example
id	string (GUID)	Milestone identifier	Required
name	string	Milestone name	Required
description	string	Milestone description	Optional
amount	number	Milestone amount	Required
status	string	Milestone status	Required
dueDate	string (date-time (UTC))	Milestone due date	Required
pricingLineItems	array of PricingLineItemResponse	Pricing breakdown	Required

PricingLineItemResponse

Field Name	Type	Description	Required / Notes / Example
id	string (GUID)	Pricing line identifier	Required
lineType	string	Pricing line type	Required
role	string	Party responsible for the fee	Required
amount	number	Amount value	Required
description	string	Pricing line description	Optional
order	integer	Display order	Required

HTTP Status Codes

Status Code	Description
200	Contract retrieved successfully
404	Contract not found
400	Invalid contract ID
401	Unauthorized
500	Internal server error